CI: modify release-notes.py to auto-categorize pull requests based on labels #4850

anshgoyalevil · 2023-10-16T20:31:00Z

Which problem is this PR solving?

fixes: [Feature]: (Re)Introduce changelog-related labels and require them for PRs #4799

Description of the changes

The modifications in release-notes.py would now make sure that the final results printed to the console are in a categorized manner which could be just copy-pasted to release-notes.
The categories object could be modified to accommodate more categories along with some meaningful titles like Changes related to CI: changelog:ci

How was this change tested?

Locally, on the jaegertracing/jaeger repo.

Checklist

I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
I have signed all commits
I have added unit tests for the new functionality
I have run lint and test steps successfully
- for jaeger: make lint test
- for jaeger-ui: yarn lint and yarn test

Signed-off-by: Ansh Goyal <[email protected]>

anshgoyalevil · 2023-10-16T20:36:25Z

scripts/release-notes.py

+categories = {
+        'CI': 'changelog:ci',
+        'Feature': 'changelog:feature',
+    }


We can modify this object as we want the result to be. For example:

categories = { '## Changes related to CI': 'changelog:ci', '## New Features': 'changelog:feature', '## Breaking changes ⚠️': 'changelog:breaking-change', }

this would categorise the PRs and would make sure the other person can just copy-paste the console logs

yes, we need to do that, and keep the order as in the current CHLG

codecov · 2023-10-16T20:38:11Z

Codecov Report

All modified lines are covered by tests ✅

📢 Thoughts on this report? Let us know!.

yurishkuro · 2023-10-16T20:40:01Z

lgtm, but one main comment: we already have a template for release notes in the CHANGELOG, so we want to match the output to that template. That means :

Having a predefined order of categories by importance (breaking changes first, then features, etc.)
Printing category headers with #### markdown (and emojis), to be copyable directly into changelog

What happens when we have commits directly to a branch without a PR?

Signed-off-by: Ansh Goyal <[email protected]>

anshgoyalevil · 2023-10-16T20:55:26Z

Having a predefined order of categories by importance (breaking changes first, then features, etc.)

Done. Since Python v3.7, insertion order matters in objects, I have kept the order as it was in previous Changelogs.

What happens when we have commits directly to a branch without a PR?

They all would go to the Others category

scripts/release-notes.py

Signed-off-by: Ansh Goyal <[email protected]>

anshgoyalevil · 2023-10-16T21:28:03Z

We can test the changes more practically, by assigning changelog labels to some of the previously merged PRs after the previous release

Signed-off-by: Ansh Goyal <[email protected]>

yurishkuro · 2023-10-16T22:56:45Z

scripts/release-notes.py

+    {'title': '#### 🚧 Experimental Features', 'label': 'changelog:exprimental'},
+    {'title': '#### CI Improvements', 'label': 'changelog:ci'},
+    {'title': '', 'label': 'changelog:test'},
+    {'title': '', 'label': 'changelog:skip'}


'title': None would be more idiomatic Python.

Makes sense. I am writing Python code for the first time :)

yurishkuro · 2023-10-16T22:57:19Z

scripts/release-notes.py

+    for category, prefix in categories.items():
+        if label.startswith(prefix):
+            return category
+    return 'Other'  # Default category if no matching prefix is found


Suggested change

return 'Other' # Default category if no matching prefix is found

return 'Uncategorized' # Default category if no matching prefix is found

yurishkuro · 2023-10-16T22:58:04Z

scripts/release-notes.py

+            commit_labels = get_pull_request_labels(token, args.repo, pull_id)
+            changelog_labels = [label for label in commit_labels if label.startswith('changelog:')]
+
+            category = 'Other'


maybe define a constant at the top

UNCATTEGORIZED = 'uncategorized'

yurishkuro · 2023-10-16T22:59:41Z

scripts/release-notes.py

@@ -88,17 +108,70 @@ def main(token, repo, num_commits, exclude_dependabot):
        if not pulls:
            short_sha = sha[:7]
            commit_url = commit['html_url']
-            print(f'* {msg} ([@{author}]({author_url}) in [{short_sha}]({commit_url}))')
+            # Check if the commit has changelog label
+            commit_labels = get_pull_request_labels(token, args.repo, pull_id)


if there are not pulls where are you getting pull_id?

Correct actually. Now, I just threw all commits without pull_ids to the UNCATEGORISED group.

yurishkuro · 2023-10-16T23:26:38Z

scripts/release-notes.py

+        for result in other_results:
+            print(result)
+
+        if skipped_dependabot:


should this be indented left?

Missed that. Thanks

Signed-off-by: Ansh Goyal <[email protected]>

yurishkuro · 2023-10-17T04:45:37Z

scripts/release-notes.py

@@ -66,6 +83,10 @@ def main(token, repo, num_commits, exclude_dependabot):
    print('Retrieved', len(commits), 'commits')

    # Load PR for each commit and print summary
+    print("Processing...")


scripts/release-notes.py

yurishkuro · 2023-10-17T04:49:32Z

scripts/release-notes.py

+    # Print categorized pull requests
+    for category, results in category_results.items():
+        if results and category:
+            print(f'{category}:')


new line after header

Do we need an empty line after the header? Currently it is like:

Header 1:
PRs Table

Header 2:
PRs Table

we do, look at the existing changelog format. In plain text markdown it's much easier to see headers when they are spaced, not jammed with text

scripts/release-notes.py

Signed-off-by: Ansh Goyal <[email protected]>

scripts/release-notes.py

yurishkuro · 2023-10-17T17:50:13Z

scripts/release-notes.py


    if skipped_dependabot:
-        print(f"\n(Skipped {skipped_dependabot} dependabot commit{'' if skipped_dependabot == 1 else 's'})")
+        if not commits_with_multiple_labels:


odd coupling of the logic, better to have each section to be self-contain, e.g. by always calling print() at the end

Signed-off-by: Ansh Goyal <[email protected]>

## Which problem is this PR solving? - related to: #4850 ## Description of the changes - This PR adds a Dynamic Loading Bar Functionality to `release-notes.py` - Knowing exactly what percentage our script is completed processing at each second provides a better UX ## How was this change tested? - Locally ![npaefr0x](https://github.com/jaegertracing/jaeger/assets/94157520/e956a443-f5a3-4162-bec0-9adce9dd43bf) ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `yarn lint` and `yarn test` Signed-off-by: Ansh Goyal <[email protected]>

anshgoyalevil added 2 commits October 17, 2023 01:52

modify release-notes script

9012eff

Signed-off-by: Ansh Goyal <[email protected]>

Merge branch 'jaegertracing:main' into main

2346909

anshgoyalevil requested a review from a team as a code owner October 16, 2023 20:31

anshgoyalevil requested a review from albertteoh October 16, 2023 20:31

anshgoyalevil commented Oct 16, 2023

View reviewed changes

anshgoyalevil added 2 commits October 17, 2023 02:22

add markdown and other labels

5147283

Signed-off-by: Ansh Goyal <[email protected]>

Merge branch 'main' of https://github.com/anshgoyalevil/jaeger

3c31c46

yurishkuro reviewed Oct 16, 2023

View reviewed changes

scripts/release-notes.py Outdated Show resolved Hide resolved

yurishkuro reviewed Oct 16, 2023

View reviewed changes

scripts/release-notes.py Outdated Show resolved Hide resolved

anshgoyalevil added 2 commits October 17, 2023 02:47

add skip and test | change to array

4f3e6cc

Signed-off-by: Ansh Goyal <[email protected]>

add skip and test | change to array

a17deac

Signed-off-by: Ansh Goyal <[email protected]>

add #### to Other title

353e023

Signed-off-by: Ansh Goyal <[email protected]>

yurishkuro reviewed Oct 16, 2023

View reviewed changes

anshgoyalevil added 2 commits October 17, 2023 08:51

make changes

e37c3df

Signed-off-by: Ansh Goyal <[email protected]>

fix indtn

a1ca8bd

Signed-off-by: Ansh Goyal <[email protected]>

yurishkuro reviewed Oct 17, 2023

View reviewed changes

scripts/release-notes.py Show resolved Hide resolved

yurishkuro reviewed Oct 17, 2023

View reviewed changes

scripts/release-notes.py Outdated Show resolved Hide resolved

anshgoyalevil added 3 commits October 17, 2023 11:44

add multiple label support

2df3670

Signed-off-by: Ansh Goyal <[email protected]>

fix newline

eb0102b

Signed-off-by: Ansh Goyal <[email protected]>

fix newline

e24b80b

Signed-off-by: Ansh Goyal <[email protected]>

fix newline

6a3edd1

Signed-off-by: Ansh Goyal <[email protected]>

akagami-harsh mentioned this pull request Oct 17, 2023

Feature: updating release-note script to validate that all PRs have changelog label #4849

Closed

1 task

yurishkuro reviewed Oct 17, 2023

View reviewed changes

anshgoyalevil added 2 commits October 17, 2023 23:33

make improvements

de15d68

Signed-off-by: Ansh Goyal <[email protected]>

add newline after titles

7d1b17c

Signed-off-by: Ansh Goyal <[email protected]>

yurishkuro approved these changes Oct 17, 2023

View reviewed changes

yurishkuro added the changelog:skip Trivial change that does not require an entry in CHANGELOG label Oct 17, 2023

yurishkuro merged commit 7cd109f into jaegertracing:main Oct 17, 2023
34 of 35 checks passed

anshgoyalevil mentioned this pull request Oct 18, 2023

chore: Add Dynamic Loading Bar Functionality to release-notes.py #4857

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CI: modify release-notes.py to auto-categorize pull requests based on labels #4850

CI: modify release-notes.py to auto-categorize pull requests based on labels #4850

anshgoyalevil commented Oct 16, 2023

anshgoyalevil Oct 16, 2023 •

edited

Loading

yurishkuro Oct 16, 2023

codecov bot commented Oct 16, 2023 •

edited

Loading

yurishkuro commented Oct 16, 2023

anshgoyalevil commented Oct 16, 2023

anshgoyalevil commented Oct 16, 2023

yurishkuro Oct 16, 2023

anshgoyalevil Oct 17, 2023

yurishkuro Oct 16, 2023

yurishkuro Oct 16, 2023

yurishkuro Oct 16, 2023

anshgoyalevil Oct 17, 2023 •

edited

Loading

yurishkuro Oct 16, 2023

anshgoyalevil Oct 17, 2023 •

edited

Loading

yurishkuro Oct 17, 2023

yurishkuro Oct 17, 2023

anshgoyalevil Oct 17, 2023

yurishkuro Oct 17, 2023

yurishkuro Oct 17, 2023

anshgoyalevil Oct 17, 2023

	return 'Other' # Default category if no matching prefix is found
	return 'Uncategorized' # Default category if no matching prefix is found

CI: modify release-notes.py to auto-categorize pull requests based on labels #4850

CI: modify release-notes.py to auto-categorize pull requests based on labels #4850

Conversation

anshgoyalevil commented Oct 16, 2023

Which problem is this PR solving?

Description of the changes

How was this change tested?

Checklist

anshgoyalevil Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 16, 2023 • edited Loading

Codecov Report

yurishkuro commented Oct 16, 2023

anshgoyalevil commented Oct 16, 2023

anshgoyalevil commented Oct 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anshgoyalevil Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anshgoyalevil Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anshgoyalevil Oct 16, 2023 •

edited

Loading

codecov bot commented Oct 16, 2023 •

edited

Loading

anshgoyalevil Oct 17, 2023 •

edited

Loading

anshgoyalevil Oct 17, 2023 •

edited

Loading